double[] (Groovy JDK enhancements)

Methods Summary

Methods
Return type	Name and parameters
`boolean`	`asBoolean()` Coerces a double array to a boolean value.
`double`	`average()` Calculates the average of the doubles in the array.
`boolean`	`contains(Object value)` Checks whether the array contains the given value.
`Number`	`count(Object value)` Counts the number of occurrences of the given value inside this array.
`DoubleStream`	`doubleStream()` Returns a sequential DoubleStream with the specified array as its source.
`Collection`	`flatten()` Flatten an array.
`List`	`getAt(IntRange range)` Support the subscript operator with an IntRange for a double array
`List`	`getAt(ObjectRange range)` Support the subscript operator with an ObjectRange for a double array
`List`	`getAt(Range range)` Support the subscript operator with a range for a double array
`List`	`getAt(Collection indices)` Support the subscript operator with a collection for a double array
`IntRange`	`getIndices()` Returns indices of the double array.
`Map`	`indexed()` Zips a double[] with indices in (index, value) order starting from index 0.
`Map`	`indexed(int offset)` Zips a double[] with indices in (index, value) order.
`String`	`join(String separator)` Concatenates the string representation of each items in this array, with the given String as a separator between each item.
`double`	`max()` Adds max() method to double arrays.
`double`	`min()` Adds min() method to double arrays.
`int`	`size()` Allows arrays to behave similar to collections.
`Stream`	`stream()` Returns a sequential Stream with the specified array as its source.
`double`	`sum()` Sums the items in an array.
`double`	`sum(double initialValue)` Sums the items in an array, adding the result to some initial value.
`double[]`	`swap(int i, int j)` Swaps two elements at the specified positions.
`List`	`toList()` Converts this array to a List of the same size, with each element added to the list.
`Set`	`toSet()` Converts this array to a Set, with each unique element added to the set.
`String`	`toString()` Returns the string representation of the given array.

- Methods Detail
  - public boolean asBoolean()
    
    Coerces a double array to a boolean value. A double array is false if the array is of length 0, and true otherwise.
    
    Returns:
    
    the array's boolean value
    
    Since:
    
    1.7.4
  - public double average()
    
    Calculates the average of the doubles in the array.
```
assert 5.0d == ([2,4,6,8] as double[]).average()
```
    Returns:
    
    The average of the items
    
    Since:
    
    3.0.0
  - public boolean contains(Object value)
    
    Checks whether the array contains the given value.
    
    Parameters:
    
    value - the value being searched for
    
    Returns:
    
    true if the array contains the value
    
    Since:
    
    1.8.6
  - public Number count(Object value)
    
    Counts the number of occurrences of the given value inside this array. Comparison is done using Groovy's == operator (using compareTo(value) == 0 or equals(value) ).
    
    Parameters:
    
    value - the value being searched for
    
    Returns:
    
    the number of occurrences
    
    Since:
    
    1.6.4
  - public DoubleStream doubleStream()
    
    Returns a sequential DoubleStream with the specified array as its source.
    
    Returns:
    
    a Stream for the array
    
    Since:
    
    3.0.8
  - public Collection flatten()
    
    Flatten an array. This array and any nested arrays or collections have their contents (recursively) added to the new collection.
    
    Returns:
    
    a flattened Collection
    
    Since:
    
    1.6.0
  - public List getAt(IntRange range)
    
    Support the subscript operator with an IntRange for a double array
    
    Parameters:
    
    range - an IntRange indicating the indices for the items to retrieve
    
    Returns:
    
    list of the retrieved doubles
    
    Since:
    
    1.0
  - public List getAt(ObjectRange range)
    
    Support the subscript operator with an ObjectRange for a double array
    
    Parameters:
    
    range - an ObjectRange indicating the indices for the items to retrieve
    
    Returns:
    
    list of the retrieved doubles
    
    Since:
    
    1.0
  - public List getAt(Range range)
    
    Support the subscript operator with a range for a double array
    
    Parameters:
    
    range - a range indicating the indices for the items to retrieve
    
    Returns:
    
    list of the retrieved doubles
    
    Since:
    
    1.0
  - public List getAt(Collection indices)
    
    Support the subscript operator with a collection for a double array
    
    Parameters:
    
    indices - a collection of indices for the items to retrieve
    
    Returns:
    
    list of the doubles at the given indices
    
    Since:
    
    1.0
  - public IntRange getIndices()
    
    Returns indices of the double array.
    
    Since:
    
    3.0.8
    
    See Also:
    
    Object[]#getIndices()
  - public Map indexed()
    
    Zips a double[] with indices in (index, value) order starting from index 0.
    
    Since:
    
    3.0.8
    
    See Also:
    
    double[]#indexed(int)
  - public Map indexed(int offset)
    
    Zips a double[] with indices in (index, value) order.
    
    Parameters:
    
    offset - an index to start from
    
    Returns:
    
    a Map (since the keys/indices are unique) containing the elements from the iterable zipped with indices
    
    Since:
    
    3.0.8
    
    See Also:
    
    Iterable#indexed(int)
  - public String join(String separator)
    
    Concatenates the string representation of each items in this array, with the given String as a separator between each item.
    
    Parameters:
    
    separator - a String separator
    
    Returns:
    
    the joined String
    
    Since:
    
    2.4.1
  - public double max()
    
    Adds max() method to double arrays.
    Example usage:
```
double[] nums = [1.1d, 2.2d, 3.3d]
assert 3.3d == nums.max()
```
    Returns:
    
    the maximum value
    
    Since:
    
    3.0.8
    
    See Also:
    
    Object[]#max()
  - public double min()
    
    Adds min() method to double arrays.
    
    Returns:
    
    the minimum value
    
    Since:
    
    3.0.8
    
    See Also:
    
    Object[]#min()
  - public int size()
    
    Allows arrays to behave similar to collections.
    
    Returns:
    
    the length of the array
    
    Since:
    
    1.0
    
    See Also:
    
    Array#getLength(java.lang.Object)
  - public Stream stream()
    
    Returns a sequential Stream with the specified array as its source.
    
    Returns:
    
    a Stream for the array
    
    Since:
    
    2.5.0
  - public double sum()
    
    Sums the items in an array.
```
assert (1+2+3+4 as double) == ([1,2,3,4] as double[]).sum()
```
    Returns:
    
    The sum of all of the items
    
    Since:
    
    2.4.2
  - public double sum(double initialValue)
    
    Sums the items in an array, adding the result to some initial value.
```
assert (5+1+2+3+4 as double) == ([1,2,3,4] as double[]).sum(5)
```
    Parameters:
    
    initialValue - the items in the array will be summed to this initial value
    
    Returns:
    
    The sum of all of the items.
    
    Since:
    
    2.4.2
  - public double[] swap(int i, int j)
    
    Swaps two elements at the specified positions.
    Example:
```
assert ([1, 3, 2, 4] as double[]) == ([1, 2, 3, 4] as double[]).swap(1, 2)
```
    Parameters:
    
    i - a position
    
    j - a position
    
    Returns:
    
    self
    
    Since:
    
    2.4.0
  - public List toList()
    
    Converts this array to a List of the same size, with each element added to the list.
    
    Returns:
    
    a list containing the contents of this array.
    
    Since:
    
    1.0
  - public Set toSet()
    
    Converts this array to a Set, with each unique element added to the set.
    
    Returns:
    
    a set containing the unique contents of this array.
    
    Since:
    
    1.8.0
  - public String toString()
    
    Returns the string representation of the given array.
    
    Returns:
    
    the string representation
    
    Since:
    
    1.6.0

Class double[]

Methods Summary

Methods Detail

public boolean asBoolean()

public double average()

public boolean contains(Object value)

public Number count(Object value)

public DoubleStream doubleStream()

public Collection flatten()

public List getAt(IntRange range)

public List getAt(ObjectRange range)

public List getAt(Range range)

public List getAt(Collection indices)

public IntRange getIndices()

public Map indexed()

public Map indexed(int offset)

public String join(String separator)

public double max()

public double min()

public int size()

public Stream stream()

public double sum()

public double sum(double initialValue)

public double[] swap(int i, int j)

public List toList()

public Set toSet()

public String toString()